4.5.4.1 查询应用列表
可通过此接口查询应用列表。
基本信息
请求地址：
https://SDPC-IP:4433/api/v3/resource/queryAll请求方式：
GET
请求头（Header）
- 请求体（Body）
| 参数 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| groupId | 应用分类id | 否 | string | 可以通过指定该参数查询指定应用分类下的应用列表； 示例： groupId=7f7d1b90-d8c0-11ee-bd37-8da372d47329 注意：当同时指定 groupId 和 groupName 时，groupId优先级更高； 推荐仅指定 groupName |
| groupName | 应用分类名称 | 否 | string | 可以通过指定该参数查询指定应用分类下的应用列表； 示例： groupName=集团内部应用 注意：当同时指定 groupId 和 groupName 时，groupId优先级更高； 推荐仅指定 groupName |
| pageSize | 分页大小 | 否 | number | 查询数据会自动分页，此参数为每页包含数据的最大条数。 取值范围：0<分页大小<=5000。 默认值：20 |
| pageIndex | 页码 | 否 | number | 查询数据会自动分页，此参数为待查询的页面序号。 取值范围：0<分页索引<=1000000。 默认值：1 |
| filter | 过滤条件 | 否 | string | 取值范围： all - 全部（默认） name - 名称 description - 描述 appAddress - 后端服务器地址 accessAddress - 前端访问地址 creator - 创建者 creatorRole - 创建者角色 |
| searchValue | 搜索关键字 | 否 | string | 搜索关键字，查询方式为模糊查询； 默认查询全部。 |
| sortBy | 排序字段 | 否 | string | 取值范围： name - 名称（默认） accessModel - 访问模式 description - 描述 status - 应用状态 appAddress - 后端服务器地址 accessAddress - 前端访问地址 creator - 创建者 creatorRole - 创建者角色 editor - 编辑者 createdAt - 创建时间 updatedAt - 更新时间 subModel - 访问子模式 nodeGroupId - 所属节点组id groupId - 应用分类id accessEntry - 浏览器打开地址 editorRole - 编辑者角色 |
| asc | 排序字段 | 否 | number | 取值范围： 1 - 升序（默认） 0 - 降序 |
| isPaged | 是否分页 | 否 | number | 取值范围： 1 - 需要分页（默认） 0 - 不需要分页 |
- 请求示例
curl --location --request GET 'https://SDPC-IP:4433/api/v3/resource/queryAll?pageSize=20&pageIndex=1&groupName=集团内部应用' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--header 'Cookie: locale=zh-cn'
- 响应数据
| 参数 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| code | 响应码 | string | OK 表示成功，其他表示出错。具体含义请参考错误码定义 |
| data | 响应数据 | object | 响应数据 |
| ├─ pageSize | 分页大小 | number | 分页大小 |
| ├─ pageIndex | 当前页码 | number | 当前页码 |
| ├─ count | 应用总数 | number | 应用总数 |
| ├─ pageCount | 总页数 | number | 总页数 |
| ├─ data | 应用列表 | object[] | 应用列表 |
| ├─ ├─ id | 应用ID | string | 应用ID |
| ├─ ├─ name | 应用名称 | string | 应用名称 |
| ├─ ├─ description | 应用描述 | string | 应用描述 |
| ├─ ├─ accessModel | 访问模式 | string | 访问模式： "WEB"表示WEB模式； "L3VPN"表示隧道模式 |
| ├─ ├─ subModel | 访问子模式 | string | 访问子模式： "WEB"表示标准WEB； "L3VPN"表示标准隧道 "TUN2WEB"表示隧道转web模式 |
| ├─ ├─ enableTransparentProxy | 是否启用透明代理 | number | 1表示透明代理模式，0表示智能改写模式 |
| ├─ ├─ groupId | 应用分类id | string | 所属应用分类ID |
| ├─ ├─ groupName | 应用分类名称 | string | 所属应用分类名称 |
| ├─ ├─ nodeGroupId | 所属节点id | string | 节点区域ID |
| ├─ ├─ nodeGroupName | 所属节点名称 | string | 节点区域名称 |
| ├─ ├─ addressList | 后端服务器地址列表 | object [] | 后端服务器地址列表，仅隧道应用 |
| ├─ ├─ ├─ protocol | 协议 | string | 协议 |
| ├─ ├─ ├─ host | 地址 | string | 地址 |
| ├─ ├─ ├─ port | 端口 | string | 端口 |
| ├─ ├─ appAddress | 后端服务器地址 | string | 后端服务器地址，仅web应用 |
| ├─ ├─ accessAddress | 前端访问地址 | string | 前端访问地址，仅web应用 |
| ├─ ├─ accessEntry | 浏览器打开地址 | string | 浏览器打开地址 |
| ├─ ├─ accessAddressAliasList | 前端访问地址别名列表 | object [] | 前端访问地址别名列表，仅web应用 |
| ├─ ├─ ├─ protocol | 协议 | string | 协议 |
| ├─ ├─ ├─ host | 地址 | string | 地址 |
| ├─ ├─ ├─ port | 端口 | string | 端口 |
| ├─ ├─ status | 应用状态 | number | 应用启用状态，0：禁用；1：启用 |
| ├─ ├─ allowApply | 是否允许自助申请 | number | 是否允许用户自助申请此应用权限权限 |
| ├─ ├─ iconId | 应用图标id | string | 应用图标id |
| ├─ ├─ iconPath | 应用图标路径 | string | 应用图标路径 |
| ├─ ├─ iconType | 应用图标类型 | string | 应用图标类型 |
| ├─ ├─ hide | 应用可见性 | number | 应用可见性 0 - 允许用户可见（显示在应用中心） 1 - 用户不可见 |
| ├─ ├─ enableAuthFree | 免认证启用状态 | number | 免认证启用状态 |
| msg | 描述信息 | string | 描述信息 |
| traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {
"count": 2,
"pageCount": 1,
"pageSize": 20,
"pageIndex": 1,
"data": [
{
"id": "4cffbdb0-daf7-11ee-99c1-ad5ce62be579",
"name": "web1",
"description": "testaaa",
"accessModel": "WEB",
"subModel": "WEB",
"groupId": "default",
"groupName": "默认分类",
"nodeGroupId": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
"nodeGroupName": "Default",
"appAddress": "https://1.2.3.4",
"accessAddress": "https://test.com",
"accessEntry": "https://test.com/客服体系/专家中心/零信任专家组",
"accessAddressAliasList": [
{
"protocol": "https:",
"port": "443",
"host": "baidu.com",
"actionList": [
"redirect",
"listen"
],
"trustedCertId": "default"
}
],
"status": 1,
"allowApply": 1,
"iconId": "1",
"iconPath": "/portal/preset_icon/batch333_000.png",
"iconType": "font",
"extConfig": {
"hide": 0
},
"enableAuthFree": 0
},
{
"id": "3d3ab920-daf7-11ee-99c1-ad5ce62be579",
"name": "tun1",
"description": "",
"accessModel": "L3VPN",
"subModel": "L3VPN",
"groupId": "default",
"groupName": "默认分类",
"nodeGroupId": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
"nodeGroupName": "Default",
"addressList": [
{
"host": "1.1.1.0-10.10.10.0",
"port": "1",
"protocol": "tcp"
}
],
"appAddress": "",
"accessAddress": "",
"accessEntry": "",
"status": 1,
"allowApply": 0,
"iconId": "1",
"iconPath": "/portal/preset_icon/batch333_000.png",
"iconType": "font",
"extConfig": {
"hide": 1
},
"enableAuthFree": 0
}
]
},
"msg": "请求成功",
"traceId": "00119cb6ef72b1ac"
}
错误码